<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - LogHound</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/DebugLogHoundLevel.html">DebugLogHoundLevel</a></li>
	
	<li><a href="../symbols/ErrorLogHoundLevel.html">ErrorLogHoundLevel</a></li>
	
	<li><a href="../symbols/FatalLogHoundLevel.html">FatalLogHoundLevel</a></li>
	
	<li><a href="../symbols/InfoLogHoundLevel.html">InfoLogHoundLevel</a></li>
	
	<li><a href="../symbols/LogHound.html">LogHound</a></li>
	
	<li><a href="../symbols/LogHoundLevel.html">LogHoundLevel</a></li>
	
	<li><a href="../symbols/LogHoundLevels.html">LogHoundLevels</a></li>
	
	<li><a href="../symbols/LogHoundMessageFilter.html">LogHoundMessageFilter</a></li>
	
	<li><a href="../symbols/LogHoundMessageLevelFilter.html">LogHoundMessageLevelFilter</a></li>
	
	<li><a href="../symbols/LogHoundMessageTagFilter.html">LogHoundMessageTagFilter</a></li>
	
	<li><a href="../symbols/LogHoundTextSearchFilter.html">LogHoundTextSearchFilter</a></li>
	
	<li><a href="../symbols/LogHoundVer.html">LogHoundVer</a></li>
	
	<li><a href="../symbols/TraceLogHoundLevel.html">TraceLogHoundLevel</a></li>
	
	<li><a href="../symbols/WarnLogHoundLevel.html">WarnLogHoundLevel</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class LogHound
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/loghound.js.html">loghound.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class LogHound.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/LogHound.html#constructor">LogHound</a></b>()
							</div>
							<div class="description">Main Log Hound object-function definition.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class LogHound.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#activateTagMode">activateTagMode</a></b>(mode)
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#addMsgFilter">addMsgFilter</a></b>(newFilter)
								</div>
								<div class="description">Adds a filter which extends LogHoundMessageFilter to the message filter
array.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#doSetup">doSetup</a></b>()
								</div>
								<div class="description">Performs the main setup for the Log Hound application.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#enableLogging">enableLogging</a></b>(enable)
								</div>
								<div class="description">Enable or disable logging.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#filterMsg">filterMsg</a></b>(msgRec)
								</div>
								<div class="description">Filters a message record based on the currently active message filters.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#getLogLevel">getLogLevel</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#getMessageLayout">getMessageLayout</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#isLoggingEnabled">isLoggingEnabled</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#isShaded">isShaded</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#isShowing">isShowing</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#log">log</a></b>(---, ---, ---, ---)
								</div>
								<div class="description">Main logging function - this is where all log messages go to die.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#logDebug">logDebug</a></b>(---, ---, ---)
								</div>
								<div class="description">Logs a message at the "debug" level.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#logError">logError</a></b>(---, ---, ---)
								</div>
								<div class="description">Logs a message at the "error" level.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#logFatal">logFatal</a></b>(---, ---, ---)
								</div>
								<div class="description">Logs a message at the "fatal" level.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#logInfo">logInfo</a></b>(---, ---, ---)
								</div>
								<div class="description">Logs a message at the "info" level.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#logTrace">logTrace</a></b>(---, ---, ---)
								</div>
								<div class="description">Logs a message at the "trace" level.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#logWarn">logWarn</a></b>(---, ---, ---)
								</div>
								<div class="description">Logs a message at the "warn" level.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#search">search</a></b>(textToMatch)
								</div>
								<div class="description">Iterates through all visible messages and hides any that do not match the
argumented string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#setKillSwitch">setKillSwitch</a></b>(killSwitch)
								</div>
								<div class="description">When set to <code>true</code> Log Hound will be completely blocked from
being initialised via the doSetup() function.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#setLogLevel">setLogLevel</a></b>(level)
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#setMessageLayout">setMessageLayout</a></b>(layout)
								</div>
								<div class="description">Sets the message layout display to either 'brief' or 'detail'.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#setMessagePaneSize">setMessagePaneSize</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#setShadeMode">setShadeMode</a></b>(shade)
								</div>
								<div class="description">Controls whether or not the Log Hound user interface is in "shade mode",
where only the header strip is visible in order to stay out of the user's
way.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#show">show</a></b>(show)
								</div>
								<div class="description">If set to a value that equates to 'true', the Log Hound UI will be shown on
the page.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#showMessageLevel">showMessageLevel</a></b>(level, show)
								</div>
								<div class="description">Shows or hides all messages for the specified level.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#toggleCtrlPanel">toggleCtrlPanel</a></b>(cmd)
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#toggleHelpPanel">toggleHelpPanel</a></b>(cmd)
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/LogHound.html#toggleTagCtrlPanel">toggleTagCtrlPanel</a></b>(cmd)
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>LogHound</b>()
				</div>
				
				<div class="description">
					Main Log Hound object-function definition.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="activateTagMode"> </a>
					<div class="fixedFont">
					
					
					<b>activateTagMode</b>(mode)
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>mode</b>
									
								</dt>
								<dd>The tag filter mode.  Must be one of four values:
<ol>
<li>any</li>
<li>exc</li>
<li>int</li>
<li>ony</li>
</ol></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="addMsgFilter"> </a>
					<div class="fixedFont">
					
					
					<b>addMsgFilter</b>(newFilter)
					
					</div>
					<div class="description">
						Adds a filter which extends LogHoundMessageFilter to the message filter
array.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/LogHoundMessageFilter.html">LogHoundMessageFilter</a>}</span> <b>newFilter</b>
									
								</dt>
								<dd>The message filter to add to the
internal array.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="doSetup"> </a>
					<div class="fixedFont">
					
					
					<b>doSetup</b>()
					
					</div>
					<div class="description">
						Performs the main setup for the Log Hound application.  This should only be
called once per page, though it protects itself against multiple calls. Log
Hound will not be functional until this method is called.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="enableLogging"> </a>
					<div class="fixedFont">
					
					
					<b>enableLogging</b>(enable)
					
					</div>
					<div class="description">
						Enable or disable logging. When set to false, logging is completely disabled,
which means no messages are processed or stored and Log Hound is basically
turned "off".
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{boolean}</span> <b>enable</b>
									
								</dt>
								<dd>Set to <code>true</code to enable logging, otherwise
<code>false</code>.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="filterMsg"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>filterMsg</b>(msgRec)
					
					</div>
					<div class="description">
						Filters a message record based on the currently active message filters.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String[]}</span> <b>msgRec</b>
									
								</dt>
								<dd>The target string array message record.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the message record should be visible
based on the currently active filters, <code>false</code> if the record
should not be visible.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getLogLevel"> </a>
					<div class="fixedFont">
					
					<span class="light">{<a href="../symbols/LogHoundLevel.html">LogHoundLevel</a>}</span>
					<b>getLogLevel</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/LogHoundLevel.html">LogHoundLevel</a>}</span> The current logging level in the form of a
LogHoundLevel object.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getMessageLayout"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>getMessageLayout</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The current message layout.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="isLoggingEnabled"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>isLoggingEnabled</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if logging is enabled.  This includes
if the kill switch is disabled as well.  If logging is disabled or the kill
switch is enabled, returns <code>false</code>.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="isShaded"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>isShaded</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the interface is in shade mode,
otherwise <code>false</code>.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="isShowing"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>isShowing</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the UI is currently visible,
otherwise <code>false</code>.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="log"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>log</b>(---, ---, ---, ---)
					
					</div>
					<div class="description">
						Main logging function - this is where all log messages go to die... or be
displayed. The arguments for this method are handled by a special argument
parser, so the order of the arguments does not matter.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/LogHoundLevel.html">LogHoundLevel</a>}</span> <b>---</b>
									
								</dt>
								<dd>The log level of the message.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>---</b>
									
								</dt>
								<dd>The message to be logged.</dd>
							
								<dt>
									<span class="light fixedFont">{String[]}</span> <b>---</b>
									
								</dt>
								<dd>An array of string tags to assign to the message.</dd>
							
								<dt>
									<span class="light fixedFont">{Error}</span> <b>---</b>
									
								</dt>
								<dd>A javascript error to parse and display.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the message was logged, or</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="logDebug"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>logDebug</b>(---, ---, ---)
					
					</div>
					<div class="description">
						Logs a message at the "debug" level.  The arguments for this method are
handled by a special argument parser, so the order of the arguments does
not matter.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>---</b>
									
								</dt>
								<dd>The message to be logged.</dd>
							
								<dt>
									<span class="light fixedFont">{String[]}</span> <b>---</b>
									
								</dt>
								<dd>An array of string tags to assign to the message.</dd>
							
								<dt>
									<span class="light fixedFont">{Error}</span> <b>---</b>
									
								</dt>
								<dd>A javascript error to parse and display.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the message was logged, or
<code>false</code> if the message was rejected for some reason.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="logError"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>logError</b>(---, ---, ---)
					
					</div>
					<div class="description">
						Logs a message at the "error" level.  The arguments for this method are
handled by a special argument parser, so the order of the arguments does
not matter.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>---</b>
									
								</dt>
								<dd>The message to be logged.</dd>
							
								<dt>
									<span class="light fixedFont">{String[]}</span> <b>---</b>
									
								</dt>
								<dd>An array of string tags to assign to the message.</dd>
							
								<dt>
									<span class="light fixedFont">{Error}</span> <b>---</b>
									
								</dt>
								<dd>A javascript error to parse and display.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the message was logged, or
<code>false</code> if the message was rejected for some reason.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="logFatal"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>logFatal</b>(---, ---, ---)
					
					</div>
					<div class="description">
						Logs a message at the "fatal" level.  The arguments for this method are
handled by a special argument parser, so the order of the arguments does
not matter.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>---</b>
									
								</dt>
								<dd>The message to be logged.</dd>
							
								<dt>
									<span class="light fixedFont">{String[]}</span> <b>---</b>
									
								</dt>
								<dd>An array of string tags to assign to the message.</dd>
							
								<dt>
									<span class="light fixedFont">{Error}</span> <b>---</b>
									
								</dt>
								<dd>A javascript error to parse and display.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the message was logged, or
<code>false</code> if the message was rejected for some reason.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="logInfo"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>logInfo</b>(---, ---, ---)
					
					</div>
					<div class="description">
						Logs a message at the "info" level.  The arguments for this method are
handled by a special argument parser, so the order of the arguments does
not matter.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>---</b>
									
								</dt>
								<dd>The message to be logged.</dd>
							
								<dt>
									<span class="light fixedFont">{String[]}</span> <b>---</b>
									
								</dt>
								<dd>An array of string tags to assign to the message.</dd>
							
								<dt>
									<span class="light fixedFont">{Error}</span> <b>---</b>
									
								</dt>
								<dd>A javascript error to parse and display.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the message was logged, or
<code>false</code> if the message was rejected for some reason.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="logTrace"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>logTrace</b>(---, ---, ---)
					
					</div>
					<div class="description">
						Logs a message at the "trace" level.  The arguments for this method are
handled by a special argument parser, so the order of the arguments does
not matter.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>---</b>
									
								</dt>
								<dd>The message to be logged.</dd>
							
								<dt>
									<span class="light fixedFont">{String[]}</span> <b>---</b>
									
								</dt>
								<dd>An array of string tags to assign to the message.</dd>
							
								<dt>
									<span class="light fixedFont">{Error}</span> <b>---</b>
									
								</dt>
								<dd>A javascript error to parse and display.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the message was logged, or
<code>false</code> if the message was rejected for some reason.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="logWarn"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>logWarn</b>(---, ---, ---)
					
					</div>
					<div class="description">
						Logs a message at the "warn" level.  The arguments for this method are
handled by a special argument parser, so the order of the arguments does
not matter.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>---</b>
									
								</dt>
								<dd>The message to be logged.</dd>
							
								<dt>
									<span class="light fixedFont">{String[]}</span> <b>---</b>
									
								</dt>
								<dd>An array of string tags to assign to the message.</dd>
							
								<dt>
									<span class="light fixedFont">{Error}</span> <b>---</b>
									
								</dt>
								<dd>A javascript error to parse and display.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> <code>true</code> if the message was logged, or
<code>false</code> if the message was rejected for some reason.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="search"> </a>
					<div class="fixedFont">
					
					
					<b>search</b>(textToMatch)
					
					</div>
					<div class="description">
						Iterates through all visible messages and hides any that do not match the
argumented string.  Calling this function will overwrite any existing value
in the search text box.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>textToMatch</b>
									
								</dt>
								<dd>The text to search for in any visible messages.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setKillSwitch"> </a>
					<div class="fixedFont">
					
					
					<b>setKillSwitch</b>(killSwitch)
					
					</div>
					<div class="description">
						When set to <code>true</code> Log Hound will be completely blocked from
being initialised via the doSetup() function.  This function is usually
used to prevent Log Hound from initilising on a global basis in instances
where your code is in an environment that you do not want the Log Hound UI
to be seen: the public version of your site as opposed to the development
version of your site, for instance.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{boolean}</span> <b>killSwitch</b>
									
								</dt>
								<dd>Set to true to block Log Hound from being
initialised.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setLogLevel"> </a>
					<div class="fixedFont">
					
					
					<b>setLogLevel</b>(level)
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/LogHoundLevel.html">LogHoundLevel</a>}</span> <b>level</b>
									
								</dt>
								<dd>The level object representing the level at
which and above the logger will record incoming messages.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setMessageLayout"> </a>
					<div class="fixedFont">
					
					
					<b>setMessageLayout</b>(layout)
					
					</div>
					<div class="description">
						Sets the message layout display to either 'brief' or 'detail'.  If Log Hound
is active, the message layout in the UI will then be changed to the
indicated layout.  If no argument or <code>null</code> is passed to this
function, the message layout will be toggled between the 'brief' and
'detail' layouts.
<p>The layout can be set before Log Hound is set up.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String|null}</span> <b>layout</b>
									
								</dt>
								<dd>Can be the values 'brief', 'display', or you can
pass no value at all.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><code>true</code> if the function call resulted in the message
layout being changed, otherwise <code>false</code>.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="setMessagePaneSize"> </a>
					<div class="fixedFont">
					
					
					<b>setMessagePaneSize</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="setShadeMode"> </a>
					<div class="fixedFont">
					
					
					<b>setShadeMode</b>(shade)
					
					</div>
					<div class="description">
						Controls whether or not the Log Hound user interface is in "shade mode",
where only the header strip is visible in order to stay out of the user's
way.  If no argument or <code>null</code> is passed, this method acts as a
toggle.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{boolean|null}</span> <b>shade</b>
									
								</dt>
								<dd><code>true</code> if the user interface should
roll up into shade mode, <code>false</code> for the user interface to roll
out. <code>null</code> to toggle the mode.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="show"> </a>
					<div class="fixedFont">
					
					
					<b>show</b>(show)
					
					</div>
					<div class="description">
						If set to a value that equates to 'true', the Log Hound UI will be shown on
the page.  If set to a 'false' value, Log Hound will be hidden. If no value
is argumented, this function acts as a toggle. Please note that while
hidden, Log Hound is still active and will continue to log messages.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{boolean|String}</span> <b>show</b>
									
								</dt>
								<dd>A value that equates to 'true'
<p>Values that equate to true:
<ul>
<li>true</li>
<li>'true'</li>
<li>'show'</li>
</ul>
All other values except <code>null</code> equate to false.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="showMessageLevel"> </a>
					<div class="fixedFont">
					
					
					<b>showMessageLevel</b>(level, show)
					
					</div>
					<div class="description">
						Shows or hides all messages for the specified level. If the 'show' argument
is null or not passed in, this function will toggle the visibility of the
specified level messages.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String|Number|<a href="../symbols/LogHoundLevel.html">LogHoundLevel</a>}</span> <b>level</b>
									
								</dt>
								<dd>The log level to show, hide, or
toggle.</dd>
							
								<dt>
									<span class="light fixedFont">{String|boolean}</span> <b>show</b>
									
								</dt>
								<dd><code>true</code> if you want the messages of
the argumented level to be visible, <code>false</code> if you want to hide
the level messages, or <code>null</code> or do not pass a value to toggle
the target level's messages.
<p>Values that equate to true:
<ul>
<li>true</li>
<li>'true'</li>
<li>'show'</li>
</ul>
All other values except <code>null</code> equate to false.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="toggleCtrlPanel"> </a>
					<div class="fixedFont">
					
					
					<b>toggleCtrlPanel</b>(cmd)
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>cmd</b>
									
								</dt>
								<dd>Can be one of four strings: display, hide, toggle, or
restore.
<ul>
<li>display:  Displays the panel.</li>
<li>hide:     Hides the panel.</li>
<li>toggle:   Toggles the panel from the saved state.</li>
<li>restore:  Restores the panel to the saved state.</li>
</ul></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="toggleHelpPanel"> </a>
					<div class="fixedFont">
					
					
					<b>toggleHelpPanel</b>(cmd)
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>cmd</b>
									
								</dt>
								<dd>Can be one of four strings: display, hide, toggle, or restore.
<ul>
<li>display:  Displays the panel.</li>
<li>hide:     Hides the panel.</li>
<li>toggle:   Toggles the panel from the saved state.</li>
<li>restore:  Restores the panel to the saved state.</li>
</ul></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="toggleTagCtrlPanel"> </a>
					<div class="fixedFont">
					
					
					<b>toggleTagCtrlPanel</b>(cmd)
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>cmd</b>
									
								</dt>
								<dd>Can be one of four strings: display, hide, toggle, or
restore.
<ul>
<li>display:  Displays the panel.</li>
<li>hide:     Hides the panel.</li>
<li>toggle:   Toggles the panel from the saved state.</li>
<li>restore:  Restores the panel to the saved state.</li>
</ul></dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Nov 14 2010 15:43:30 GMT-0500 (EST)
		</div>
	</body>
</html>
